Docs: runnable model tasks and verified book links - #53
Open
stefan-jansen wants to merge 1 commit into
Open
stefan-jansen wants to merge 1 commit into
stefan-jansen wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Outcome
A reader can run a bounded PCA forecast from the README or Quickstart with the base wheel, verify
(2, 6)finite output, and follow task guides to exact generated API signatures and pinned public teaching files. The mobile documentation menu is visible at widths where Material hides tabs.Closes #52.
Capability inventory
latent_factor_pipeline.py;latent_factor_variants.pystochastic_discount_factor.pydirect_asset_prediction.pyportfolio_learning.py;portfolio_neural.pyintegration_handoff.pyml4t.models; Chapter 14 notebook 09 illustrates related analysisThe public
0.1API has no designated experimental model family._internalis unstable. The package does not fetch data, compute diagnostics, or simulate trades. Neural examples requiredeep; Parquet and Specs adapters requireintegration. Two-to-four-step neural smoke runs verify contracts only. Full book training and case-study registry runs need book data and longer compute.Verification
ml4t_models-0.1.4-py3-none-any.whl. Installed it into clean Python 3.12 environments under/tmp, one base and one withdeep, and ran the README block, Quickstart block, and all seven repository examples from outside the source tree. All assertions passed.portfolio_learning.pyalso passed in the base-only environment.d2edec54b1c7a6a9d7a97d8129eb05db4491e1ebofstefan-jansen/machine-learning-for-trading. Checked 10 distinct linked files against its Git tree and inspected notebook code forml4t.modelsuse. Chapter 14 teaching notebooks 04-09 and Chapter 17 notebooks 11-13 do not call the library; the case-studylibrary_bridge.pydoes.ty check, 423 tests, coverage gate (95.49% lines, 85.29% branches),uv build, andpre-commit run --all-filespassed. Commit hook passed the same configured checks.Review limits and follow-up
CI result
At public commit
39926d7703dba87204c01094102343edddcc057a, all 33 completed PR checks passed, including the cross-platform Python matrix and MPS neural qualification. Two workflow jobs were skipped by their configured conditions, including the RTX 3090 CUDA and performance job. GitHub reports the PR mergeable with a clean merge state.